iPool Commandline Options
This section provides an overview of the different batch files used in iPool and the commandline options available for each. Each batch file has its own set of options and arguments that control how it operates. The tabs below list the most common batch files for specific scenarios and each utility. Each tab contains command‑line options, expected arguments, and a description of what each option does.
- Common Batch Files
- iPool
- iBidEzy
- iBidAgg
- iYBidWESM
Initialize Database
DefInIt.bat
| Option | Description | Argument |
|---|---|---|
| -ipdb | Initializes the input database | SysWESM25.94.mdb |
| -tpdb | Initializes the time periods database | TimePeriods.mdb |
| -ibdb | Initializes the bidding database | iBidWESM.mdb |
| -ifdb | Initializes the flow database | iFloWESM.mdb |
| -isdb | Initializes the scenario database | iScen.mdb |
| -5mnDisp | Sets the time interval to 5 minutes | 1 = enabled, 0 = disabled |
Historical Bids
RunBids.bat
RunBids.bat
| Option | Description | Argument |
|---|---|---|
| -izero | Set MW bids to zero for missing interval bids (enabled by default) | 1 = enabled, 0 = disabled |
| -bdor | Read RTDOR files and set spinmax/spinres priorities based on reserve MW bids | (No argument required) |
| -t | Sets the start date of bids | yyyyMMdd |
Historical Load
RunHistorical.bat
| Option | Description | Argument |
|---|---|---|
| -new | Creates a new scenario | (No argument required) |
| -t | Sets the start date of the historical run | “MM/dd/yyyy” |
| -ndays | Sets the number of days for simulation | Any whole number (user-defined) |
| -rep | Sets the number of report files | 0 = minimum, 3 = maximum |
| -5mnDisp | Sets the time interval to 5 minutes | 1 = enabled, 0 = disabled |
| -GenList | Saves the latest genlist.csv file provided | File name as saved |
| -s | Saves a file | User-defined file name |
| -x | Closes a file | (No argument required) |
| -o | Opens a file | (No argument required) |
| -updatedb | Automatically updates the database with detected changes to sites and units | (No argument required) |
| -checkinputs | Checks if the input files are complete | (No argument required) |
| -rb | Retains loaded bids | (No argument required) |
| -bDAP | Shifts logic to Day Ahead Projection (DAP) instead of RTD (Optional) | (No argument required) |
| -bWAP | Shifts logic to Week Ahead Projection (WAP) instead of RTD (Optional) | (No argument required) |
Backcast Calibration
RunBackcast.bat
| Option | Description | Argument |
|---|---|---|
| -d | Load demand file | File name (e.g., Demand_HISTORICAL.csv, DemandHR_HISTORICAL) |
| -g | Load generation file | File name (e.g., MRGCFac_HISTORICAL.csv, MRHCFac_HISTORICAL.csv) |
| -ab | Autobid loading, extract outages for x hours | Any whole number |
| -abf | Sets the site type of outages | ALL, COAL, or CCGT |
| -e | Load event file | File name (e.g., Ev_Historical.csv) |
| -pcsr | Adjust the reserve calibration factor | Any number from 0.1 to 100 |
| -bt | Includes only bids within the specified calendar time period | WORKDAY, SAT, SUN, DEFAULT, DEFAULT_PRIORITY |
| -bf | Loads the custom bid with a specified time period (-bt) | File name as saved. Example: 01GNPD_U01.bid |
| -spin | Sets the spinning reserves | 1 = enabled, 0 = disabled |
Aggregate Bids
RunBidAgg.bat
| Option | Description | Argument |
|---|---|---|
| -t | Specifies start date of files to process | yyyyMMdd |
| -cap | Includes all bids or bids with available capacity above the specified percentage (0–100). | Any number between 0 and 100. Example: -cap 0 Includes all bids or bids with above 0% avail capacity. |
| -cap_COAL | Includes only bids with available capacity equal to or greater than the specified percentage (0–100) for COAL type units. | Any number between 0 and 100. |
| -cap_CCGT | Includes only bids with available capacity equal to or greater than the specified percentage (0–100) for CCGT type units. | Any number between 0 and 100. |
| -cap_HYDRO | Includes only bids with available capacity equal to or greater than the specified percentage (0–100) for HYDRO type units. | Any number between 0 and 100. |
| -cap_GEO | Includes only bids with available capacity equal to or greater than the specified percentage (0–100) for GEO type units. | Any number between 0 and 100. |
| -bt | Includes only bids within specified calendar time | WORKDAY, SAT, SUN, DEFAULT, or DEF_PRIORITY |
| -s | Saves the aggregated bid file | File name |
| -log | Outputs a log file reporting empty bids removed | (No argument) |
What-if Scenarios
RunWIF.bat
| Option | Description | Argument |
|---|---|---|
| -d | Load demand file | File name (e.g., DemandHR_HISTORICAL.csv) |
| -g | Load generation file | File name (e.g., MRHCFac_HISTORICAL.csv) |
| -out | Forced unit outage | Unit ID (e.g., 01SUAL_G01) |
| -dx | Multiply demand by a value | Example: -dx 1.02 (increase by 2%) |
| -opELP | Optimize bids for Energy Limited Plants | (No argument) |
| -bset | Load a CSV file containing bids | FileName.csv |
| -bt | Apply bid to time period | DEF_PRIORITY or DEFAULT |
| -bf | Load bid file | FileName.bid |
| -ib | Load intelligent bid file | FileName.ibd |
| -UnitsFile | Update site from CSV file | Units.csv |
| -SitesFile | Update site from CSV file | Sites.csv |
| -StorsFile | Update storages from CSV file | Storages.csv |
| -stor | Include storages | ALL or Storage ID (e.g., KALAYAAN) |
Forecast
RunFC.bat
| Option | Description | Argument |
|---|---|---|
| -s | Sets the file name of a scenario | File name |
| -d | Load the forecasted demand file | File name (e.g., DemandForecast.csv) |
| -g | Load the forecasted generation file | File name (e.g., GenerationForecast.csv) |
| -bset | Load a CSV file that contains bids | FileName.csv |
| -pcsr | Adjust the Reserve Calibration Factor | Any number from 0.1 to 100 |
| -e | Load an event file | File name (e.g., Events.csv) |
| -r | Random seed for Monte Carlo simulation | 100 |
| -n | Number of Monte Carlo samples | Any number ≤ 100 (e.g., 100) depending on user's requirements |
Add Custom Storage
RunSTO.bat
| Option | Description | Argument |
|---|---|---|
| -d | Load demand file | File name (e.g., DemandHr_HISTORICAL.csv) |
| -g | Load generation file | File name (e.g., MRHCFac_HISTORICAL.csv) |
| -ab | Autobid loading, extract outages for x hours | Any whole number |
| -abf | Sets the site type of outages | ALL, COAL, or CCGT |
| -e | Load event file | File name (e.g., Ev_Historical.csv) |
| -eset | Load set of event file | File name (e.g., Evset_Historical.csv) |
| -pcsr | Adjust the reserve calibration factor | Any number from 0.1 to 100 |
| -bt | Includes only bids within the specified calendar time period | WORKDAY, SAT, SUN, DEFAULT, DEFAULT_PRIORITY |
| -bf | Loads the custom bid with a specified time period (-bt) | Filename.bid |
| -spin | Sets the spinning reserves | 1 = enabled, 0 = disabled |
| -opELP | Optimize bids for Energy Limited Plants | (No argument) |
| -UnitsFile | Update unit from CSV file | Units.csv |
| -SitesFile | Update site from CSV file | Sites.csv |
| -StorsFile | Update storages from CSV file | Storages.csv |
Zonal Configuration
RunZones.bat
| Option | Description | Argument |
|---|---|---|
| -setzones | Converts regions to zones | (No argument required) |
| -nowin | Opens a file without a Windows pop‑up | (No argument required) |
| -ipdb | Sets iPool database system | FileName.mdb |
Create Custom Bids
RunBidEzy.bat
| Option | Description | Argument |
|---|---|---|
| -unit | Creates an empty bid file containing only the specified unit | Unit ID Example: 01SUAL_G01 |
| -s | Save the file as FileName.bid | FileName.bid |
| -bid_flat | Creates a flat bid of the specified price to all the bids in the currently loaded bid file. If price is 0, the price defaults to the corresponding SRMC of each unit in the bid file. The bid quantity is set to the maximum MW of each unit. | Bid price (depending on user’s requirements) |
| bid_peak | Creates a peak bid of the specified price to all the bids in the currently loaded bid file. If price is 0, the price defaults to the corresponding SRMC of each unit in the bid file. The bid quantity is set to the Max MW of each unit. | Bid price (depending on user’s requirements) |
| -bid_pop | Creates a peak-offpeak bid of the specified peak price to all the bids in the currently loaded bid file. The off peak price defaults to the corresponding SRMC of each unit in the bid file. The bid quantity is set to the Max MW of each unit. | Bid price (depending on user’s requirements) |
| -swap | Replaces the corresponding bid from the existing bid file or adds the bid to the file if there is no corresponding bid | FileName.bid |
Folders
| Option | Description | Argument |
|---|---|---|
| -dbdir | Database folder | Databases |
| -bdir | Bid folder | Bids |
| -ddir | Demand | Demands |
| -gdir | Must run generation folder | Generations |
| -sdir | Scenario location | Scenarios |
| -hdir | Market data | WESM FILES |
Databases
| Option | Description | Argument |
|---|---|---|
| -ipdb | iPool system database | SysWESM2XXX.mdb |
| -tpdb | Calendar database | TimePeriods.mdb |
| -isdb | iScen database | iEnergyDT.mdb |
| -ifdb | iFlow database | iFloWESM.mdb |
| -ibdb | iBid database | iBidWESM.mdb |
| -ipjs | json file | json.js |
| -updatedb | Updates system database | |
| -setzones | Converts regions to zones for WESM only | |
| -deletesite | Deletes site from scenario & database | SiteID |
| -deleteunit | Deletes unit from scenario & database | UnItID |
Market
| Option | Description | Argument |
|---|---|---|
| -HR0 | Starting hour of market. 0 = WESM, 4 = AEMO | 0 or 4 |
| -MPC | Set Market Price Cap | 32000 |
| -VOLL | Value of loss of load = max price | 32000 |
| -VOLG | Value of loss gen = min price | 40- |
| -VOCE | Value of carbon emissions PhP/ MWh | 500 |
| -iprul | Pool pricing rule. | 0 = Nodal, 1 = Nodal Ave, 2 = Zonal, 3 = Zonal Ave, 4 = Postage, 5 = Uniform |
Scenario Options
| Option | Description | Argument |
|---|---|---|
| -SCEN_ID | Load existing scenario | |
| -o | Open existing scenario | BASE |
| -new | Create new scenario | BASENew |
| -t | Set startdate | MM/dd/yyyy |
| -ndays | Set number of days | 7 |
| -s | Save or save as | Filename |
| -x | exit | (No argument required) |
| -5mnDisp | Set dispatch interval. 0 = hourly, 1 = 5 minute | 0 or 1 |
| -group | Include group sites | BATTERY, BIO, CCGT, COAL, DIESEL, DISPDEM, GEO, HYDRO, MR_ALL, OCGT, PUMP, ROR, SOLAR, STGAS, WIND |
| -portfolio | Include market players | ALL, Participant ID |
| -stor | Include storages | ALL, Storage ID |
Input Files
| Option | Description | Argument |
|---|---|---|
| -df | Load meter data file | MeterData.csv |
| -c | Load contract file | Filename.csv |
| -bset | Loads set of bid files | BidSet.csv |
| -eset | Loads set of event files | EventSet.csv |
| -SitesFile | Update sites from Sites csv | Sites.csv |
| -UnitsFile | Update units from Units csv | Units.csv |
| -StorsFile | Update storages from Storages csv | Storages.csv |
Reporting Options
| Option | Description | Argument |
|---|---|---|
| -rep | Report options. | 0 = minimal, 1 = medium, 2 = high, 3 = maximum |
| -remark | Comments on scenario | Optional remarks |
| -OutID | Print outages of the indicated object ID | ALL, 01SUAL, … |
| -nowin | No windows pop-up | (No argument required) |
| -NoDis | No dispatch simulation | (No argument required) |
| -skin | Interface skin from skincrafter | Avalon.skf |
| -ts | Time starting | 0 or 1 |
| -SimLog | Print simulatio log at indicated dispatch time | 10/21/2025 7:00 |
| -hist | Historical simulation | (No argument required) |
| -rb | Retain loaded bids | (No argument required) |
| -ExcPS | Excludes pump and demand units in the region demand in WESM historical load | (No argument required) |
| -checkinputs | checks if input files are complete | (No argument required) |
Load Profiling & Pricing
| Option | Description | Argument |
|---|---|---|
| -iLoad | Load profile analysis, forecast and comparison | Analyze, Forecast, ReForecast or Compare |
| -ACFile | Historical input file | acdemand.csv |
| -FCFile | Forecast output file | fcdemand.csv |
| -bWeight | Chronological weighting | 0 or 1 |
| -idt | % profile irregularity threshold for validation & NTL detection | 50 |
| -ObID | Meter IDs or Region IDs | meter01, meter02, … |
| -Dfac | Forecasted demand multiplier for each ID | 1.02 |
| -FCDate | Forecast start date | 10/21/20XX |
| -FCDays | Forecast number of days | 7 |
| -dmod | Demand model file | Dmod_ScenID.csv |
| -pmod | Tariff price profile file | Tariffs.csv |
| -tm | Historical temperature input file | TempHST.csv |
| -tmfc | Forecast temperature input file | TempFC.csv |
| -Dfac | Default demand growth rate factor | 1.05 |
| -pf | Scenario price revalue file | Prices.csv |
| -p | Load Prices.csv to a scenario | Prices.csv |
Backcast & Calibration
| Option | Description | Argument |
|---|---|---|
| -run | Run simulation | (No argument required) |
| -d | Load region demand file | Demand.csv |
| -g | Load must run cf file | MRGCFac.csv |
| -e | Load event file | Ev_BCA.csv |
| -ab | Autobid loading. Extract outages >= 336 hrs | 336 |
| -abf | Outages of Sites Type | ALL, COAL, CCGT |
| -dr | Region ID | CLUZ, CVIS or CMIN |
| -dx | Multiply demand | 1.02 |
| -da | Add to demand | 200 |
| -dm | Subtract from demand | 100 |
| -i | Adjust price by CPI factor | 1.02 |
| -spin | Reserve (spinning) On/Off | 0 or 1 |
| -pcsr | Adjust by % reserve factor | 1.5 |
| -pcms | Adjust by % SRmaxcap/maxspin | 20 |
| -pmin | Set unit min load On/Off | 0 or 1 |
| -ramp | Set ramp limits On/Off | 0 or 1 |
| -elim | Set energy limits On/Off | 0 or 1 |
| -mlf | Use marginal loss factors | 0 or 1 |
| -cba | Carbon bid adjustment using ratio of VOCE/base value of carbon emissions PhP/MWh | 1200 |
| -px | Bid price multiplying factor | 1.2 |
| -MINFLOOR | Use for calibrating demand side response | 3000 |
What If Scenarios
| Option | Description | Argument |
|---|---|---|
| -du | Apply to unit ID | 01SUAL_G01 |
| -out | Forced unit outage | 01SUAL_G01 |
| -in | Forced unit in service | 01SUAL_G01 |
| -bf | Load bid file | 01SUAL.bid |
| -bt | Apply bid to Time Period | DEF_PRIORITY |
| -ilp | Interruptible loads On/Off | 0 or 1 |
Secondary Pricing
| Option | Description | Argument |
|---|---|---|
| -ipcap | Secondary pricing. CPT On/Off | 0 or 1 |
| -pcap | Secondary price cap PhP/MWh | 6500 |
| -pave | Secondary price ave trigger PhP/MWh | 9000 |
| -phrs | Secondary price consecutive hours | 168 |
Network Constraints
| Option | Description | Argument |
|---|---|---|
| -link | Apply to link ID | VISLUZ1 |
| -lim | Link limit profile | VISLUZ1_LIM.csv |
| -dlf | Dynamic loss factors On/Off | 0 or 1 |
| -gc | Generic constraints On/Off | 0 or 1 |
| -gcid | Generic constraints eqtn ID | GENC0N1 |
| -gcto | Link constraints to eqtn ID | VISLUZ1_TO1 |
| -gcfr | Link constraints fr eqtn ID | VISLUZ1_FR1 |
| -multi | Single region or multi region pool | 0 or 1 |
| -nolim | Sets high limit on all links | (No argument required) |
Must Run Weather Data
| Option | Description | Argument |
|---|---|---|
| -mrs | Must run solar file | MRESOLAR_2025.csv |
| -mrw | Must run wind file | MREWIND_2025.csv |
| -mrec | Must run energy conversion ON | 0 or 1 |
| -mrdb | Must run db update | (No argument required) |
| -PoEH | PoE Curve high elbow pt | 0.3 |
| -PoEL | PoE Curve low elbow pt | 0.6 |
| -PoEHs | PoE high elbow pt Solar option | 0.3 |
| -PoELs | PoE low elbow pt Solar option | 0.7 |
Monte Carlo
| Option | Description | Argument |
|---|---|---|
| -n | Monte Carlo samples | 30 |
| -r | Random seed | 100 |
| -rd | Number of days before startdate to start random outages | 1000 |
| -rwth | Random weather. MR wind traces are randomized | (No argument required) |
| -avx | Availability multiply factor | 0.95 |
| -m | Maintenance ON | (No argument required) |
| -ib | Load intelligent bid file | LSHW.ibd |
| -cost | Use cost based dispatch not bid based | 1, 2, or 3 |
Optimisation
| Option | Description | Argument |
|---|---|---|
| -opELP | Optimised bids for Energy Limited Plants | (No argument required) |
| -opbid | Optimisation of bids for storage system | Storage ID |
| -op | Optimisation ON | (No argument required) |
| -optp | Optimise object type | Player, Sites, Site, Unit |
| -opid | Optimise object ID | 01SUAL |
| -opf | Optimise contracted demand file | DemCont.csv |
| -opco | Optimise SRMC cost/MWh | 4000 |
| -opch | Optimise change limit factor | 0.5 |
| -opcf | Optimise capfac limit factor | 0.85 |
| -opsn | Optimise sensitivity | 0.1 |
| -iret | 0 = retailer, 1 = generator | 0 or 1 |
Custom Bids
| Option | Description | Argument |
|---|---|---|
| -file.bid | Load the bid file | none |
| -bdir | Set the bid directory | "c:\bids" |
| -S | Save the loaded file or save the file as File.bid. | File.bid |
| -X | Exit program after performing the commands | |
| -region | Creates an empty bid file containing only the specified region | LUZON |
| -site | Creates an empty bid file containing only the specified site | 1MARIVELES |
| -unit | Creates an empty bid file containing only the specified unit | 1MARVEL_G01 |
| -bt | Set the time period of the bid | WEEKDAY |
| -clr | Clears file of empty bids | |
| -swap | Replaces or adds bid to the file | 1MARVEL_G01 |
| -inc_reg | Includes the region into the currently loaded bid file | LUZON |
| -inc_ste | Includes the site into the currently loaded bid file | 1MARIVELES |
| -exc_reg | Excludes the region from the currently loaded bid file | LUZON |
| -exc_ste / -extract_reg / -extract_typ | Excludes site / extracts stations by region / extracts stations by type | 1MARIVELES LUZON WIND |
| -px | Multiplies the bid prices by the given factor across all hours | 1.2 |
| -peak | Limits -px, -add and -sub commands to peak hours only | |
| -maxprc | Limits the prices of the bid to the given maximum price | 8000.0 |
| -minprc | Limits the prices of the bid to the given minimum price | 2000.0 |
| -from | Specifies price bands to include in -add, -sub, -qx | 5000.0 |
| -add | Adds the value to bid prices | 100.0 |
| -sub | Subtracts the value from bid prices | 100.0 |
| xb- / -CX | Scales bid quantities or total available capacity | 1.2 |
| -bid_flat | Creates a flat bid of the specified price | 4000.0 |
| -bid_peak | Creates a peak bid of the specified price | 9000.0 |
| -bid_pop | Creates a peak-offpeak bid of the specified peak price | 7000.0 |
| -pcq / -scopy | Sets bid quantity to given percent x Max MW | 80.0 filename |
Aggregate Bids
| Option | Description | Argument |
|---|---|---|
| -t | Specifies start date of files to process. | "20230301" |
| -ndays | Process files with dates up to 90 days from the start date. | 30 |
| -cap | Includes all bids or bids with available capacity above the specified percentage (0–100). | Any number between 0 and 100. Example: -cap 0 Includes all bids or bids with above 0% avail capacity. |
| -cap_COAL | Includes only bids with available capacity equal to or greater than the specified percentage (0–100) for COAL type units. | Any number between 0 and 100. |
| -cap_CCGT | Includes only bids with available capacity equal to or greater than the specified percentage (0–100) for CCGT type units. | Any number between 0 and 100. |
| -cap_HYDRO | Includes only bids with available capacity equal to or greater than the specified percentage (0–100) for HYDRO type units. | Any number between 0 and 100. |
| -cap_GEO | Includes only bids with available capacity equal to or greater than the specified percentage (0–100) for GEO type units. | Any number between 0 and 100. |
| -fixed | Excludes bids with fixed MW. | (No argument required) |
| -bt | Includes only bids within the specified calendar time period. | WORKDAY, SAT, SUN, DEFAULT, DEFAULT_PRIORITY |
| -log | Outputs a log file reporting on units with empty bids removed. | (No argument required) |
| -stat | Outputs statistics on availability factors, capacity factors and load factors. | (No argument required) |
| -byPrc | Use method of price bucketing rather than by bid bands in averaging bid quantities and prices. | (No argument required) |
| -all | Loads all files inside the bid directory. | (No argument required) |
Load Historical Bids
| Option | Description | Argument |
|---|---|---|
| -t | Sets the start date of bids | yyyyMMdd |
| -n | Number of days in total from the start day to be converted. | n |
| -izero | Set MW bids to zero for missing interval bids (enabled by default) | 1 = enabled, 0 = disabled |
| -bdor | Read RTDOR files and set spinmax/spinres priorities based on reserve MW bids | 1 |